Skip to content

Comments

scope3 rtd: update default params and docs#14378

Merged
patmmccann merged 2 commits intoprebid:masterfrom
scope3data:s3rtd_default_keys
Jan 30, 2026
Merged

scope3 rtd: update default params and docs#14378
patmmccann merged 2 commits intoprebid:masterfrom
scope3data:s3rtd_default_keys

Conversation

@gravelg
Copy link
Contributor

@gravelg gravelg commented Jan 23, 2026

Type of change

  • Bugfix

  • Feature

  • New bidder adapter

  • Updated bidder adapter

  • Code style update (formatting, local variables)

  • Refactoring (no functional changes, no api changes)

  • Build related changes

  • CI related changes

  • Does this change affect user-facing APIs or examples documented on http://prebid.org?

  • Other

Description of change

Updated default params to match docs in code and markdown

Other information

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8f156696d7

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment on lines 113 to +117
moduleConfig.endpoint = moduleConfig.endpoint || DEFAULT_ENDPOINT;
moduleConfig.timeout = moduleConfig.timeout || DEFAULT_TIMEOUT;
moduleConfig.includeKey = moduleConfig.includeKey || 'scope3_include';
moduleConfig.excludeKey = moduleConfig.excludeKey || 'scope3_exclude';
moduleConfig.macroKey = moduleConfig.macroKey || 'scope3_macro';
moduleConfig.includeKey = moduleConfig.includeKey || 'axei';
moduleConfig.excludeKey = moduleConfig.excludeKey || 'axex';
moduleConfig.macroKey = moduleConfig.macroKey || 'axem';

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve backward compatibility for default keys

Changing the default includeKey/excludeKey/macroKey values here means any publisher who relied on the previous defaults (i.e., did not explicitly set these params and already created GAM line items with the old key names) will suddenly stop matching targeting after this update. That’s a behavior regression for existing integrations; consider keeping the old defaults, supporting both sets of keys during a transition, or providing an explicit migration path to avoid breaking live line items.

Useful? React with 👍 / 👎.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are purposely changing this wrong default

Copy link
Collaborator

@patmmccann patmmccann Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a breaking change, we do not typically allow this in a minor version. Do you have a reason you think it is okay to break everyone, eg this is a bugfix and it actually fixes them?

@coveralls
Copy link
Collaborator

coveralls commented Jan 23, 2026

Pull Request Test Coverage Report for Build 21406962611

Details

  • 3 of 3 (100.0%) changed or added relevant lines in 1 file are covered.
  • 2 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.001%) to 96.217%

Files with Coverage Reduction New Missed Lines %
libraries/medianetUtils/logger.js 2 83.78%
Totals Coverage Status
Change from base Build 21359463030: -0.001%
Covered Lines: 208849
Relevant Lines: 217061

💛 - Coveralls

Copy link
Collaborator

@patmmccann patmmccann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no breaking changes in minor versions

@patmmccann patmmccann changed the title s3rtd: update default params and docs scope3 rtd: update default params and docs Jan 27, 2026
@patmmccann
Copy link
Collaborator

@gravelg happy to merge on the 11 branch; does that work for you guys?

@gravelg
Copy link
Contributor Author

gravelg commented Jan 29, 2026

Hey @patmmccann , sorry for the delay in response. For context, we only have two clients using this module right now and they are both setting the "new" keys in their config manually. While this is technically a breaking change, the current default configuration will simply not work with how we tell people to do the setup in GAM.

@patmmccann
Copy link
Collaborator

fair enough, i will merge given only two clients and both of them aware

@patmmccann patmmccann merged commit 020d175 into prebid:master Jan 30, 2026
102 checks passed
@muuki88
Copy link
Collaborator

muuki88 commented Feb 2, 2026

docs change: prebid/prebid.github.io#6409

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants